4D Chart v13

CT GET LEGEND ATTRIBUTES

Home

 
4D Chart v13
CT GET LEGEND ATTRIBUTES

CT GET LEGEND ATTRIBUTES 


 

CT GET LEGEND ATTRIBUTES ( area ; object ; display ; orientation ; reverseOrder ; reverseKey ; location ; horizOffset ; vertOffset ) 
Parameter Type   Description
area  Longint in 4D Chart area
object  Longint in Object ID
display  Integer in Is legend displayed? 0 = No 1 = Yes
orientation  Integer in Receives orientation of the series in the legend 0 = Horizontal 1 = Vertical
reverseOrder  Integer in Using reverse order? 0 = Not reversed 1 = Reversed
reverseKey  Integer in Key and text reversed? 0 = Not reversed 1 = Reversed
location  Integer in Receives location code
horizOffset  Integer in Receives horizontal offset from plot's left side in points
vertOffset  Integer in Receives vertical offset from plot's top side in points

The CT GET LEGEND ATTRIBUTES command returns the attributes of the legend specified by area and object in the variables for the display, orientation, reverseOrder, reverseKey, location, horizOffset, and vertOffset parameters.

display specifies whether or not the legend is displayed.

orientation specifies whether the series in the legend are displayed vertically or horizontally with regard to each other. The following are examples of vertical and horizontal legends:

Vertical Legend    Horizontal Legend


reverseOrder specifies whether the order of the series in the legend is reversed.

reverseKey specifies whether the series label and the key that explains the unique pattern and color of the series are reversed. The default is to show the key to the left of the label.

The following table lists the codes for the location parameter:

CodeLocation
0Legend’s location is not one of the built-in locations
1Top left
2Bottom left
3Top right
4Bottom right
5Left
6Right
7Top
8Bottom

horizOffset and vertOffset are used when location is not one of the built-in legend locations (location = 0). horizOffset is expressed in points from the left side of the graph to the left side of the legend. vertOffset is expressed in points from the top of the graph to the top of the legend.

Note: To get the text attributes of legend text, use the CT GET CHART TEXT ATTRIBUTES command.

Example  

This example gets the legend text attributes for the chart specified by $ChartID.

 CT GET LEGEND ATTRIBUTES(Area;$ChartID;$Display;$Orient;$ReverseO;$ReverseK;$Location;$HorizOff;$VertOff

 
PROPERTIES 

Product: 4D Chart
Theme: CT Chart
Number: 14537

 
INDEX

Alphabetical list of commands

 
HISTORY 

Created: 4D Chart 1

 
SEE ALSO 

CT GET CHART TEXT ATTRIBUTES
CT Get legend text
CT SET LEGEND ATTRIBUTES
CT SET LEGEND TEXT